onSearchResultTooLarge Event

Arguments

eobject

An object that contains the following properties:

reasonFailedstring: The reason why the search failed.
payloadSizenumeric: The amount of data downloaded.
rowCountnumeric: The number of rows returned.
maxPayloadAllowednumeric: The maximum amount of data permitted to be downloaded in bytes.
maxRowsAllowednumeric: The maximum number of rows allowed.

Description

Fires if the user executes a server-side search that returns too many records.

Discussion

Typically used in mobile applications when you want to ensure that the user is not trying to retrieve too much data from the server. Allows you to display UI telling the user to enter more restrictive search criteria. The maximum allowed search size is set in the List builder, but can be overwritten by properties set in the <listObject>.searchList() method.